V2 doc update #154
Merged
V2 doc update #154
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adobeDan
suggested changes
Apr 7, 2017
| `--test-mode`: causes User Sync to run through all processing including querying the directory and calling the Adobe User Management APIs to process the request, but no actual action is taken. No users are created, deleted, or altered. | ||
|
|
||
| `--update-user-info`: causes User Sync to check for changes in first name, last name, or email address of users and make updates to the Adobe information if it does not match the directory information. Specifying this option increases run time so you may not want to include it on each run. | ||
| `--update-user-info`: causes User Sync to check for changes in first name, last name, or email address of users and make updates to the Adobe information if it does not match the directory information. Specifying this option may increases run time. |
Contributor
There was a problem hiding this comment.
"may increases" -> "may increase"
| User Sync helps you manage Adobe product licenses by allowing you to place users into directory groups using the directory system interface or other tools. Those groups are then mapped to Adobe user groups or PCs. The mapping is part of the User Sync configuration file. When User Sync detects that directory users are in one of these mapped groups, the user is added to the corresponding Adobe user group or PC. Similarly, users in the user group or PC but not in the corresponding directory group are removed from the user group or PC. | ||
|
|
||
| ☐ Decide if you will manage license allocation using User Sync. If not, you can skip the remaining steps for now, but you will still need to do them and manually add users to the user groups or PCs later using the Adobe Admin Console. | ||
| ☐ Decide if you will manage license allocation using User Sync. If not, you can skip the remaining steps for now, but you will still need to do them and then manually add users to the user groups or PCs later using the Adobe Admin Console. |
Contributor
There was a problem hiding this comment.
This is really hard to follow. Maybe some thing like "If not, you can skip the remaining steps; however, before the users you create can access Adobe products, you will need to manually add them to product configurations using the Adobe Admin Console."
| ☐ Decide if you will manage license allocation using User Sync. If not, you can skip the remaining steps for now, but you will still need to do them and then manually add users to the user groups or PCs later using the Adobe Admin Console. | ||
|
|
||
| ☐ Create the PCs in the Adobe Admin console for the configurations of products and groups of users you will be managing. | ||
| ☐ Create the PCs in the Adobe Admin console for the configurations of products and groups of users you will be managing. Add the comment "Managed by User Sync - do not edit" to the description field of the PC. |
Contributor
There was a problem hiding this comment.
"configurations of products" -> "product configurations". (They are not actually configurations of products, and we never use that phrase.)
Also, did you define PC somewhere that I haven't seen? Like somewhere where you say "... product configuration (PC)"?
| ☐ Create the PCs in the Adobe Admin console for the configurations of products and groups of users you will be managing. | ||
| ☐ Create the PCs in the Adobe Admin console for the configurations of products and groups of users you will be managing. Add the comment "Managed by User Sync - do not edit" to the description field of the PC. | ||
|
|
||
| ☐ If you are going to use User Groups, create them and add them to the PC(s) representing product licenses to be issued to members of the user group. Add the comment "Managed by User Sync - do not edit" to the description field of the user group. |
Contributor
There was a problem hiding this comment.
product configurations do not represent product licenses. Maybe something like "If you are going to use User Groups to manage product access, you will need to first create the user groups and the product configurations, then you can manage product access by adding each user group to the appropriate product configurations."
| ### Directory Access Configuration File | ||
|
|
||
| If you are driving User Sync from a file, you can skip this step. Setup a csv file with your entire user list following the "csv inputs - user and remove lists/1 users-file.csv" file example. This file is in the examples.config.tar.gz download from the release. | ||
| If you are driving User Sync from a file, you can skip setting up connector-ldap.yml and instead create a csv file with your entire user list following the "csv inputs - user and remove lists/1 users-file.csv" file example. This file is in the examples.config.tar.gz download from the release. |
Contributor
There was a problem hiding this comment.
We haven't been making this file. Assuming we are going to do that again, we should name it "example-configurations.tar.gz".
| ☐ Edit the connector-umapi.yml. Put in the information from the adobe.io integration you created earlier. This would be the org\_id, api\_key, client\_secret, and tech\_acct. | ||
|
|
||
| ☐ Place the private key file in the user_sync_tool folder The priv\_key\_path config file items is then set to the name of this file. | ||
| ☐ Place the private key file in the user_sync_tool folder The priv\_key\_path config file item is then set to the name of this file. |
Contributor
There was a problem hiding this comment.
You are missing a period after "user_sync_tool folder".
|
|
||
| - Directory side users are still created on the Adobe side even if one of the exclude parameters would then exclude the user on the Adobe side from updates in successive runs. That is, these parameters apply only to Adobe users who exist when the Adobe directory is being matched against the customer directory. | ||
|
|
||
| - Accounts that would have been removed or updated but were not because of this feature are listed as `info` level log entries. |
Contributor
There was a problem hiding this comment.
Actually, they are listed as debug level log entries, not info. Only the count of these users is at info level.
adobeDan
approved these changes
Apr 7, 2017
vossen-adobe
added a commit
to vossen-adobe/user-sync-fork
that referenced
this pull request
Dec 7, 2020
test_mode for Sign sync
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.